Der Einstieg in das Testen der DocuGenerate-API ist mit Postman ganz einfach – einem leistungsstarken Tool für die API-Entwicklung und -Tests. Postman vereinfacht das Erstellen von API-Anfragen, das Prüfen von Antworten und die Optimierung Ihres Test-Workflows.
In diesem Artikel führen wir den Prozess anhand des Stellenangebots-Schreibens aus dem Blogbeitrag 4 verschiedene Methoden zur Massengenerinung von Angebotsschreiben durch, um mehrere Dokumente zu generieren.
Was ist Postman?
Postman ist eine umfassende API-Entwicklungsumgebung, mit der Sie APIs entwerfen, testen und dokumentieren können. Es bietet eine benutzerfreundliche Oberfläche zum Senden von HTTP-Anfragen, zur Organisation Ihrer API-Endpunkte und zur Verwaltung Ihrer Testumgebungen. Ob Entwickler, Tester oder Teil eines DevOps-Teams – Postman kann Ihre API-Test- und Entwicklungsprozesse verbessern.
Postman-Collection importieren
Um den Testprozess zu vereinfachen, importieren Sie die DocuGenerate API-Collection in Postman. Nach dem Import sollten Sie die Template- und Document-Endpunkte wie im folgenden Bild aufgelistet sehen:
Mit API-Schlüssel authentifizieren
Für den Start des Tests mit der DocuGenerate-API in Postman ist es wichtig, den Authorization-Bereich in der Postman-Collection einzurichten.
Obwohl dieser Artikel den Demo-Schlüssel 491c000c5fad32ed7787005b0723ad55 verwendet, empfiehlt es sich, ihn für die tatsächliche Verwendung durch Ihren eigenen API-Schlüssel zu ersetzen. Ihren individuellen API-Schlüssel können Sie nach dem Einloggen in DocuGenerate auf der Einstellungsseite abrufen.
Dokumente generieren
Navigieren Sie zum Endpunkt Document / Generate Document in der Postman-Collection und geben Sie den template_id-Parameter an. Wenn Sie eine Vorlage mit dem Stellenangebots-Schreiben erstellt haben, verwenden Sie die ID dieser Vorlage.
Stellen Sie außerdem sicher, dass Sie form-data als Body-Typ auswählen, damit die POST-Anfrage den multipart/form-data-Inhaltstyp verwendet, der für einen erfolgreichen API-Aufruf erforderlich ist.
Geben Sie für den data-Parameter den Datensatz ein, der für die Dokumentgenerierung verwendet werden soll. Das erwartete Format ist ein Array von JSON-Objekten, wobei jedes JSON-Objekt Schlüssel enthält, die den Zusammenführungs-Tags der Vorlage entsprechen.
Der output_format-Parameter ist optional, wobei der Standardwert .docx ist. Sie haben die Flexibilität, die Dokumente in alternativen Formaten wie .pdf, .doc oder .odt zu generieren, wie in der API-Referenz beschrieben.
Nach der Verarbeitung gibt die API ein JSON-Objekt für das neu erstellte Dokument zurück. Im Antwortobjekt enthält das Feld document_uri einen Link zum generierten PDF:
{
"filename": "Job Offer Letter.pdf",
"created": 1696365915580,
"data_length": 20,
"name": "Job Offer Letter",
"format": ".pdf",
"template_id": "ZtHBhb9jLh6TcZuaVteI",
"document_uri": "https://storage.googleapis.com/...",
"id": "7JxcR3Q1EVKqljsTvHqc"
}
Durch die Nutzung von Postman können Sie Ihren Testprozess optimieren, potenzielle Probleme identifizieren und die reibungslose Integration von DocuGenerate in Ihre Anwendungen sicherstellen.